Pular para o conteúdo principal

Criar uma Tarifa

A API do tarifador serve como uma ferramenta útil para controlar quanto você cobra de seus clientes

Casos de uso

  1. Cobrança baseada em assinatura
  • Uma empresa de SaaS quer cobrar dos clientes com base no número de chamadas de API que eles fazem a cada mês.
  1. Modelo de pagamento por uso
  • Um provedor cobra dos clientes com base no número de transações.
POST 'apisandbox-billing-api.delfinance.com.br/billing-accounts'

Headers

Name                                         Description                                         
x-delfinance-api-keyObrigatório. API key

Corpo da requisição

NomeTypeDescription
bankAccountstringObrigatório. Conta bancária que será cobrada
intervalstringO intervalo em que o cliente será cobrado
- minute - A cobrança será ativada a cada minuto
- hour - A cobrança será ativada a cada hora
- day - A cobrança será ativada a cada dia
- week - A cobrança será ativada a cada semana
- month - A cobrança será ativada a cada mês
- year - A cobrança será ativada a cada ano
chargeFeeTypeenumQual tipo de transação seu cliente será cobrado
- 7 - TED enviado
- 8 - TED recebido
- 10 - Pix enviado
- 11 - Pix recebido
- 12 - Pix reembolsado recebido
- 13 - Pix reembolsado enviado
- 21 - TED reembolsado
- 43 - Reembolso administrativo de Pix
- 78 - Pix reembolsado enviado (desfazimento)
- 133 - Pix debitado via MED RDR (desfazimento)
- 9001 - Mensalidade Escrow
- 9002 - Mensalidade de API
amountnumberValor que será cobrado em intervalo definido
startDatedateA data em que o cálculo da tarifa começa.
paymentDatedateData em que ocorrerá o primeiro pagamento, após esta data será cobrado através do 'interval' definido

Exemplo

{
"bankAccount": "10138",
"interval": "day",
"chargeFeeType": "11",
"amount": 10,
"startDate": "2024-01-01",
"paymentDate": "2024-01-01"
}

Resposta

Em caso de resposta bem-sucedida, você receberá um código de status 204